<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>SessionHandler | @vertx/web</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@vertx/web</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="sessionhandler.html">SessionHandler</a>
				</li>
			</ul>
			<h1>Class SessionHandler</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>A handler that maintains a {@link io.vertx.ext.web.Session} for each browser
							session.
							<p>
								It looks up the session for each request based on a session cookie which
								contains a session ID. It stores the session when the response is ended in
								the session store.
								<p>
									The session is available on the routing context with
									{@link RoutingContext#session()}.
									<p>
										The session handler requires a <a href="cookiehandler.html">CookieHandler</a> to be on the routing
									chain before it.</p>
					</div>
					<dl class="tsd-comment-tags">
						<dt>author</dt>
						<dd><p><a href="http://tfox.org">Tim Fox</a></p>
						</dd>
					</dl>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">SessionHandler</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel">
				<h3>Implements</h3>
				<ul class="tsd-hierarchy">
					<li><span class="tsd-signature-type">any</span></li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#default_cookie_http_only_flag" class="tsd-kind-icon">DEFAULT_<wbr>COOKIE_<wbr>HTTP_<wbr>ONLY_<wbr>FLAG</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#default_cookie_secure_flag" class="tsd-kind-icon">DEFAULT_<wbr>COOKIE_<wbr>SECURE_<wbr>FLAG</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#default_nag_https" class="tsd-kind-icon">DEFAULT_<wbr>NAG_<wbr>HTTPS</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#default_sessionid_min_length" class="tsd-kind-icon">DEFAULT_<wbr>SESSIONID_<wbr>MIN_<wbr>LENGTH</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#default_session_cookie_name" class="tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>NAME</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#default_session_cookie_path" class="tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>PATH</a></li>
								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#default_session_timeout" class="tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>TIMEOUT</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Methods</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#handle" class="tsd-kind-icon">handle</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setauthprovider" class="tsd-kind-icon">set<wbr>Auth<wbr>Provider</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setcookiehttponlyflag" class="tsd-kind-icon">set<wbr>Cookie<wbr>Http<wbr>Only<wbr>Flag</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setcookiesecureflag" class="tsd-kind-icon">set<wbr>Cookie<wbr>Secure<wbr>Flag</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setminlength" class="tsd-kind-icon">set<wbr>Min<wbr>Length</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setnaghttps" class="tsd-kind-icon">set<wbr>Nag<wbr>Https</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setsessioncookiename" class="tsd-kind-icon">set<wbr>Session<wbr>Cookie<wbr>Name</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setsessioncookiepath" class="tsd-kind-icon">set<wbr>Session<wbr>Cookie<wbr>Path</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="sessionhandler.html#setsessiontimeout" class="tsd-kind-icon">set<wbr>Session<wbr>Timeout</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="sessionhandler.html#create" class="tsd-kind-icon">create</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
					<a name="default_cookie_http_only_flag" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>COOKIE_<wbr>HTTP_<wbr>ONLY_<wbr>FLAG</h3>
					<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>COOKIE_<wbr>HTTP_<wbr>ONLY_<wbr>FLAG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in index.d.ts:2982</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Default of whether the cookie has the HttpOnly flag set More info:
							<a href="https://www.owasp.org/index.php/HttpOnly">https://www.owasp.org/index.php/HttpOnly</a></p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
					<a name="default_cookie_secure_flag" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>COOKIE_<wbr>SECURE_<wbr>FLAG</h3>
					<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>COOKIE_<wbr>SECURE_<wbr>FLAG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in index.d.ts:2989</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Default of whether the cookie has the &#39;secure&#39; flag set to allow transmission
							over https only. More info: <a href="https://www.owasp.org/index.php/SecureFlag">https://www.owasp.org/index.php/SecureFlag</a></p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
					<a name="default_nag_https" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>NAG_<wbr>HTTPS</h3>
					<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>NAG_<wbr>HTTPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in index.d.ts:2975</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Default of whether a nagging log warning should be written if the session
							handler is accessed over HTTP, not HTTPS</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
					<a name="default_sessionid_min_length" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>SESSIONID_<wbr>MIN_<wbr>LENGTH</h3>
					<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>SESSIONID_<wbr>MIN_<wbr>LENGTH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in index.d.ts:2996</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Default min length for a session id. More info:
							<a href="https://www.owasp.org/index.php/Session_Management_Cheat_Sheet">https://www.owasp.org/index.php/Session_Management_Cheat_Sheet</a></p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
					<a name="default_session_cookie_name" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>NAME</h3>
					<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in index.d.ts:2955</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Default name of session cookie</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
					<a name="default_session_cookie_path" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>PATH</h3>
					<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>PATH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in index.d.ts:2961</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Default path of session cookie</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
					<a name="default_session_timeout" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>SESSION_<wbr>TIMEOUT</h3>
					<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>TIMEOUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in index.d.ts:2968</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Default time, in ms, that a session lasts for without being accessed before
							expiring.</p>
						</div>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Methods</h2>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="handle" class="tsd-anchor"></a>
					<h3>handle</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>arg0<span class="tsd-signature-symbol">: </span><a href="routingcontext.html" class="tsd-signature-type">RoutingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:2998</li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>arg0: <a href="routingcontext.html" class="tsd-signature-type">RoutingContext</a></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setauthprovider" class="tsd-anchor"></a>
					<h3>set<wbr>Auth<wbr>Provider</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Auth<wbr>Provider<span class="tsd-signature-symbol">(</span>authProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AuthProvider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3076</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set an auth provider that will allow retrieving the User object from the session to the current routing context.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>authProvider: <span class="tsd-signature-type">AuthProvider</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>any auth provider.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setcookiehttponlyflag" class="tsd-anchor"></a>
					<h3>set<wbr>Cookie<wbr>Http<wbr>Only<wbr>Flag</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Cookie<wbr>Http<wbr>Only<wbr>Flag<span class="tsd-signature-symbol">(</span>httpOnly<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3044</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Sets whether the &#39;HttpOnly&#39; flag should be set for the session cookie. When
										set this flag instructs browsers to prevent Javascript access to the the
									cookie. Used as a line of defence against the most common XSS attacks.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>httpOnly: <span class="tsd-signature-type">boolean</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>true to set the HttpOnly flag on the cookie</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setcookiesecureflag" class="tsd-anchor"></a>
					<h3>set<wbr>Cookie<wbr>Secure<wbr>Flag</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Cookie<wbr>Secure<wbr>Flag<span class="tsd-signature-symbol">(</span>secure<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3034</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Sets whether the &#39;secure&#39; flag should be set for the session cookie. When set
										this flag instructs browsers to only send the cookie over HTTPS. Note that
										this will probably stop your sessions working if used without HTTPS (e.g. in
									development).</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>secure: <span class="tsd-signature-type">boolean</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>true to set the secure flag on the cookie</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setminlength" class="tsd-anchor"></a>
					<h3>set<wbr>Min<wbr>Length</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Min<wbr>Length<span class="tsd-signature-symbol">(</span>minLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3068</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set expected session id minimum length.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>minLength: <span class="tsd-signature-type">number</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the session id minimal length</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setnaghttps" class="tsd-anchor"></a>
					<h3>set<wbr>Nag<wbr>Https</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Nag<wbr>Https<span class="tsd-signature-symbol">(</span>nag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3023</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set whether a nagging log warning should be written if the session handler is
									accessed over HTTP, not HTTPS</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>nag: <span class="tsd-signature-type">boolean</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>true to nag</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setsessioncookiename" class="tsd-anchor"></a>
					<h3>set<wbr>Session<wbr>Cookie<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Session<wbr>Cookie<wbr>Name<span class="tsd-signature-symbol">(</span>sessionCookieName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3052</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the session cookie name</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>sessionCookieName: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the session cookie name</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setsessioncookiepath" class="tsd-anchor"></a>
					<h3>set<wbr>Session<wbr>Cookie<wbr>Path</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Session<wbr>Cookie<wbr>Path<span class="tsd-signature-symbol">(</span>sessionCookiePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3060</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the session cookie path</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>sessionCookiePath: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the session cookie path</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setsessiontimeout" class="tsd-anchor"></a>
					<h3>set<wbr>Session<wbr>Timeout</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Session<wbr>Timeout<span class="tsd-signature-symbol">(</span>timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3014</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the session timeout</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>timeout: <span class="tsd-signature-type">number</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the timeout, in ms.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
					<a name="create" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
						<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>sessionStore<span class="tsd-signature-symbol">: </span><a href="sessionstore.html" class="tsd-signature-type">SessionStore</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in index.d.ts:3006</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Create a session handler</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>sessionStore: <a href="sessionstore.html" class="tsd-signature-type">SessionStore</a></h5>
									<div class="tsd-comment tsd-typography">
										<p>the session store</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="sessionhandler.html" class="tsd-signature-type">SessionHandler</a></h4>
							<p>the handler</p>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-class">
						<a href="sessionhandler.html" class="tsd-kind-icon">Session<wbr>Handler</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#default_cookie_http_only_flag" class="tsd-kind-icon">DEFAULT_<wbr>COOKIE_<wbr>HTTP_<wbr>ONLY_<wbr>FLAG</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#default_cookie_secure_flag" class="tsd-kind-icon">DEFAULT_<wbr>COOKIE_<wbr>SECURE_<wbr>FLAG</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#default_nag_https" class="tsd-kind-icon">DEFAULT_<wbr>NAG_<wbr>HTTPS</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#default_sessionid_min_length" class="tsd-kind-icon">DEFAULT_<wbr>SESSIONID_<wbr>MIN_<wbr>LENGTH</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#default_session_cookie_name" class="tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>NAME</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#default_session_cookie_path" class="tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>COOKIE_<wbr>PATH</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#default_session_timeout" class="tsd-kind-icon">DEFAULT_<wbr>SESSION_<wbr>TIMEOUT</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#handle" class="tsd-kind-icon">handle</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setauthprovider" class="tsd-kind-icon">set<wbr>Auth<wbr>Provider</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setcookiehttponlyflag" class="tsd-kind-icon">set<wbr>Cookie<wbr>Http<wbr>Only<wbr>Flag</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setcookiesecureflag" class="tsd-kind-icon">set<wbr>Cookie<wbr>Secure<wbr>Flag</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setminlength" class="tsd-kind-icon">set<wbr>Min<wbr>Length</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setnaghttps" class="tsd-kind-icon">set<wbr>Nag<wbr>Https</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setsessioncookiename" class="tsd-kind-icon">set<wbr>Session<wbr>Cookie<wbr>Name</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setsessioncookiepath" class="tsd-kind-icon">set<wbr>Session<wbr>Cookie<wbr>Path</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="sessionhandler.html#setsessiontimeout" class="tsd-kind-icon">set<wbr>Session<wbr>Timeout</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
								<a href="sessionhandler.html#create" class="tsd-kind-icon">create</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>